<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>volatility.conf.ConfObject : API documentation</title>
    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
    <link href="apidocs.css" type="text/css" rel="stylesheet" />
    
    
  </head>
  <body>
    <h1 class="class">v.c.ConfObject(<span title="object">object</span>) : class documentation</h1>
    <p>
      <span id="part">Part of <a href="volatility.html">volatility</a>.<a href="volatility.conf.html">conf</a></span>
      
      <a href="classIndex.html#volatility.conf.ConfObject">View In Hierarchy</a>
    </p>
    <div>
      <p>Known subclasses: <a href="volatility.conf.DummyConfig.html">volatility.conf.DummyConfig</a></p>
    </div>
    <div>This is a singleton class to manage the configuration.</p>
<p>This means it can be instantiated many times, but each instance
refers to the global configuration (which is set in class
variables).</p>
<p>NOTE: The class attributes have static dicts assigned to
facilitate singleton behaviour. This means all future instances
will have the same dicts.<table class="fieldTable"></table></div>

    
    
    <div id="splitTables">
      <table class="children sortable" id="id1431">
  
  
<tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#__init__">__init__</a></td>
    <td><span>This is a singleton object kept in the class</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#set_usage">set_usage</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#add_file">add_file</a></td>
    <td><span>Adds a new file to parse</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#print_help">print_help</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#add_help_hook">add_help_hook</a></td>
    <td><span>Adds an epilog to the help message</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#set_help_hook">set_help_hook</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#parse_options">parse_options</a></td>
    <td><span>Parses the options from command line and any conf files currently added.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#remove_option">remove_option</a></td>
    <td><span>Removes options both from the config file parser and the command line parser</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#add_option">add_option</a></td>
    <td><span>Adds options both to the config file parser and the command line parser.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#update">update</a></td>
    <td><span>This can be used by scripts to force a value of an option</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#get_value">get_value</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.conf.ConfObject.html#__getattr__">__getattr__</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr>
  
</table>
      
      
    </div>
    
    
    

    <div class="function">
  <a name="volatility.conf.ConfObject.__init__">
    
  </a>
  <a name="__init__">
    
  </a>
  <div class="functionHeader">
    
    def
    __init__(self):
    
  </div>
  <div class="functionBody">
    
    <div>This is a singleton object kept in the class<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.conf.ConfObject.set_usage">
    
  </a>
  <a name="set_usage">
    
  </a>
  <div class="functionHeader">
    
    def
    set_usage(self, usage=None, version=None):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.conf.ConfObject.add_file">
    
  </a>
  <a name="add_file">
    
  </a>
  <div class="functionHeader">
    
    def
    add_file(self, filename, _type='init'):
    
  </div>
  <div class="functionBody">
    
    <div>Adds a new file to parse<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.conf.ConfObject.print_help">
    
  </a>
  <a name="print_help">
    
  </a>
  <div class="functionHeader">
    
    def
    print_help(self):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.conf.ConfObject.add_help_hook">
    
  </a>
  <a name="add_help_hook">
    
  </a>
  <div class="functionHeader">
    
    def
    add_help_hook(self, cb):
    
  </div>
  <div class="functionBody">
    
    <div>Adds an epilog to the help message<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.conf.ConfObject.set_help_hook">
    
  </a>
  <a name="set_help_hook">
    
  </a>
  <div class="functionHeader">
    
    def
    set_help_hook(self, cb):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.conf.ConfObject.parse_options">
    
  </a>
  <a name="parse_options">
    
  </a>
  <div class="functionHeader">
    
    def
    parse_options(self, final=True):
    
  </div>
  <div class="functionBody">
    
    <div>Parses the options from command line and any conf files
currently added.</p>
<p>The final parameter should be only called from main programs
at the point where they are prepared for us to call exit if
required; (For example when we detect the -h parameter).<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.conf.ConfObject.remove_option">
    
  </a>
  <a name="remove_option">
    
  </a>
  <div class="functionHeader">
    
    def
    remove_option(self, option):
    
  </div>
  <div class="functionBody">
    
    <div>Removes options both from the config file parser and the
command line parser</p>
<p>This should only by used on options <em>before</em> they have been read,
otherwise things could get very confusing.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.conf.ConfObject.add_option">
    
  </a>
  <a name="add_option">
    
  </a>
  <div class="functionHeader">
    
    def
    add_option(self, option, short_option=None, cache_invalidator=True, **args):
    
  </div>
  <div class="functionBody">
    
    <pre>Adds options both to the config file parser and the
command line parser.

Args:
  option:            The long option name.
  short_option:      An optional short option.
  cache_invalidator: If set, when this option
                     changes all caches are invalidated.</pre>
  </div>
</div><div class="function">
  <a name="volatility.conf.ConfObject.update">
    
  </a>
  <a name="update">
    
  </a>
  <div class="functionHeader">
    
    def
    update(self, key, value):
    
  </div>
  <div class="functionBody">
    
    <div>This can be used by scripts to force a value of an option<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.conf.ConfObject.get_value">
    
  </a>
  <a name="get_value">
    
  </a>
  <div class="functionHeader">
    
    def
    get_value(self, key):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.conf.ConfObject.__getattr__">
    
  </a>
  <a name="__getattr__">
    
  </a>
  <div class="functionHeader">
    
    def
    __getattr__(self, attr):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div>
    <address>
      <a href="index.html">API Documentation</a> for Volatility 2.2, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2013-06-24 15:16:10.
    </address>
  </body>
</html>